Use newer vega versions for altair compatibility #959

JarnoRFB · 2018-09-11T20:36:11Z

Newer versions of vega, vega-lite and vega-embed are used to allow the
usage of altair 2.x. Additionally,
the JavaScript for embedding is adapted. jsdelivr is used instead of
cloudflare, since it allows to specify the newest minor version very
nicely and it is recommended by the vega-lite docs
https://vega.github.io/vega-lite/usage/embed.html#cdn

Newer versions of vega, vega-lite and vega-embed are used. Additionally, the JavaScript for embedding is adapted. jsdelivr is used instead of cloudflare, since it allows to specify the newest minor version very nicely and it is recommended by the vega-lite docs https://vega.github.io/vega-lite/usage/embed.html#cdn

JarnoRFB · 2018-09-11T20:38:56Z

Hi folium team,
just stumbled upon the old vega version, that caused plots to not work with altair 2.x. If you like the idea of updating, than this feature could probably use some tests.

Conengmo

I appreciate your PR, it is good to keep up to date with these libraries. But since the change from Vega 2 to 3 (and Vega Lite 1 to 2 also?) is not backwards compatible, I would like to give users the option to keep using the previous version. What do you think would be the best way to implement this?

Conengmo · 2018-09-17T09:33:28Z

folium/features.py

@@ -232,7 +232,7 @@ class VegaLite(Element):

    def __init__(self, data, width=None, height=None,
                 left='0%', top='0%', position='relative'):
-        super(VegaLite, self).__init__()
+        super(self.__class__, self).__init__()


Please keep this PR clean and don't change this here.

I somehow got a strange error at some point, when I used VegaLite instead of self.__class__, but I can revert that.

What was the error?

Conengmo · 2018-09-17T09:35:50Z

folium/features.py

            name='d3')

        figure.header.add_child(
-            JavascriptLink('https://cdnjs.cloudflare.com/ajax/libs/vega/2.6.5/vega.min.js'),  # noqa
+            JavascriptLink('https://cdn.jsdelivr.net/npm/vega@3'),


I like this kind of cdn url

Conengmo · 2018-09-17T09:39:26Z

folium/features.py

-                {{this.get_name()}}, embedSpec, function(error, result) {}
-            );
+            const spec = {{this.json}};
+            vegaEmbed({{this.get_name()}}, spec)


It seems vegaEmbed is the function to use in vega embed version 3, while vg.embed was used in version 2, is that right?

yes, that seems to be the case.

Conengmo · 2018-09-17T09:42:43Z

folium/features.py

@@ -232,7 +232,7 @@ class VegaLite(Element):

    def __init__(self, data, width=None, height=None,


You're only updating VegaLite it seems, why not Vega also?

good point, will do

JarnoRFB · 2018-09-17T10:12:04Z

Thanks for the review! I also thought about leaving support for VegaLite 1, but when I tried it out, it seemed to be backwards compatible at least for a simple examples and I first wanted to find out if this feature is desired at all. I think the easiest way to keep backwards compatible support would be to query the $schema field of the vega lite spec. I will add this soon when I find the time.

Conengmo · 2018-09-28T09:25:55Z

I think the easiest way to keep backwards compatible support would be to query the $schema field of the vega lite spec

Sounds like a good idea. If someone specifies the $schema field, use that version, else use the most recent version. We do have to mention that in the docs though.

I was thinking about the best place to do the switching. Maybe in the render method of the Vega and VegaLite classes. I hope you can find a way to implement the necessary if switching statements while keep the code clean.

I will add this soon when I find the time.

Thanks! Looking forward to improving our Vega (Lite) support.

JarnoRFB · 2018-11-16T16:58:48Z

I finally found time to do this. Let me know what you think of the code, I will add a section describing the changes to the docs then. I now implemented this only for vegalite, as this is relevant for altair. I would prefer to take care of vega in a separate PR.

ocefpaf · 2018-12-11T17:59:39Z

folium/features.py

@@ -112,7 +113,8 @@ def render(self, **kwargs):
                                            'if it is not in a Figure.')

        figure.header.add_child(
-            JavascriptLink('https://cdnjs.cloudflare.com/ajax/libs/leaflet-dvf/0.3.0/leaflet-dvf.markers.min.js'),  # noqa
+            JavascriptLink('https://cdnjs.cloudflare.com/ajax/libs/leaflet-dvf/0.3.0/leaflet-dvf.markers.min.js'),
+            # noqa


Please keep this all in one line.

ocefpaf · 2018-12-11T18:14:31Z

folium/features.py

@@ -208,6 +210,10 @@ def render(self, **kwargs):
            name='vega_parse')


+def get_vega_versions(spec):


Is this used somewhere?

ocefpaf · 2018-12-11T18:20:40Z

Something is not OK with the background, this is our notebook example with this PR:

…ium into feature/vega-version-update

JarnoRFB · 2018-12-12T08:22:09Z

Thanks for the review! I incorporated the comments. Regarding the background issue, I will probably wait until #1040 is merged. Then it might work as intended.

ocefpaf · 2018-12-12T11:51:14Z

Thanks for the review! I incorporated the comments. Regarding the background issue, I will probably wait until #1040 is merged. Then it might work as intended.

Yep. That is not caused by this PR.

ocefpaf · 2018-12-12T11:52:21Z

folium/features.py

+    def _get_vegalite_major_versions(self, spec):
+        try:
+            schema = spec['$schema']
+            version = os.path.splitext(os.path.split(schema)[1])[0].lstrip('v')


Do you need os to split schema here? I'm just thinking that we can avoid one extra import.

I think one could solve it just with str.split, but the os functions more direct and have somewhat speaking names. I also think importing os does not harm as it is in the standard library.

I'm +0.5 on that. Indeed os is standard lib, but it is an extra import that is used for a simple task. I would also argue that .split('/') is more readble than .path.splitext which is intended for file system paths.

Convinced! Even needs one method call less this way.

ocefpaf · 2018-12-12T13:31:47Z

folium/features.py

        except KeyError:
            major_version = None
+        else:
+            major_version = schema.split('/')[-1].split('.')[0].lstrip('v')


1-line and less code 😄
Thanks!

ocefpaf

I'll leave this one for @Conengmo to merge b/c he was the first reviewer, but LGTM.
Thanks @JarnoRFB for the awesome fix and support for multiple versions.

ocefpaf · 2018-12-13T15:59:59Z

folium/features.py

+
+    def _vega_embed(self):
+        self._parent.script.add_child(Element(Template("""
+                    const spec = {{this.json}};


The spec here will need a unique name or we won't be able to display more than 1 object.

I found a simple fix by just avoiding using the spec variable. However, we should test against this case for the future. Unfortunately I have no idea how to do this, as the error is happening on the JS side. Just executing a test with two VegaLite elements does not throw an error.
Putting an example in the example notebooks might be a way, but could look a bit awkward and is also not caught by pytest.

I found a simple fix by just avoiding using the spec variable.

Great!

However, we should test against this case for the future. Unfortunately I have no idea how to do this, as the error is happening on the JS side. Just executing a test with two VegaLite elements does not throw an error.
Putting an example in the example notebooks might be a way, but could look a bit awkward and is also not caught by pytest.

Yeah, that is hard. We can create a map and compare an expected output but that may not catch errors like that. We do build all the maps in the example gallery and check them ~~always~~ (sometimes) before merging a PR.

Maybe one could start a headless selenium browser and check if the map and the charts are there. But that would be maybe a bit two much for this PR. I can easily provide a notebook example for now and try to tackle more elaborate testing in a separate PR if that is fine for you.

That kind of testing is in our TODO list for a long time and I agree, it is something for another PR.

This one is good to go, just waiting for @Conengmo last 👍 to merge it.

Conengmo · 2018-12-23T10:25:05Z

Thanks @JarnoRFB for your effort! And thanks @ocefpaf for the review.

Looking forward to the same for Vega!

Conengmo reviewed Sep 17, 2018

View reviewed changes

jtbaker mentioned this pull request Sep 19, 2018

Use javascript template literal in Popup #962

Merged

Conengmo added the waiting for changes This PR has been reviewed and changes are needed before merging label Oct 15, 2018

JarnoRFB added 2 commits November 16, 2018 16:06

Merge branch 'master' into feature/vega-version-update

e1b8f7c

Allow multiple versions of vegalite to be used

9b1c12b

Use v2 as default vegalite version

8d8b431

Conengmo added waiting for review PR is waiting to be reviewed and removed waiting for changes This PR has been reviewed and changes are needed before merging labels Nov 25, 2018

Merge branch 'master' into feature/vega-version-update

d2652ee

ocefpaf reviewed Dec 11, 2018

View reviewed changes

ocefpaf mentioned this pull request Dec 11, 2018

Popup width #1040

Merged

JarnoRFB added 2 commits December 12, 2018 09:15

Online JS links and remove function stub

f930c67

Merge branch 'feature/vega-version-update' of github.com:JarnoRFB/fol…

e6c1fc6

…ium into feature/vega-version-update

ocefpaf reviewed Dec 12, 2018

View reviewed changes

Get major vegalite version without os module

f7e4a5c

ocefpaf reviewed Dec 12, 2018

View reviewed changes

ocefpaf approved these changes Dec 12, 2018

View reviewed changes

ocefpaf reviewed Dec 13, 2018

View reviewed changes

Fix error due to redeclaration of js variable

37dc352

Conengmo merged commit 761cc3e into python-visualization:master Dec 23, 2018

Conengmo removed the waiting for review PR is waiting to be reviewed label Dec 23, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use newer vega versions for altair compatibility #959

Use newer vega versions for altair compatibility #959

JarnoRFB commented Sep 11, 2018

JarnoRFB commented Sep 11, 2018

Conengmo left a comment

Conengmo Sep 17, 2018

JarnoRFB Sep 17, 2018

ocefpaf Dec 11, 2018

Conengmo Sep 17, 2018

Conengmo Sep 17, 2018

JarnoRFB Sep 17, 2018

Conengmo Sep 17, 2018

JarnoRFB Sep 17, 2018

JarnoRFB commented Sep 17, 2018

Conengmo commented Sep 28, 2018

JarnoRFB commented Nov 16, 2018

ocefpaf Dec 11, 2018

ocefpaf Dec 11, 2018

ocefpaf commented Dec 11, 2018

JarnoRFB commented Dec 12, 2018

ocefpaf commented Dec 12, 2018

ocefpaf Dec 12, 2018

JarnoRFB Dec 12, 2018

ocefpaf Dec 12, 2018

JarnoRFB Dec 12, 2018

ocefpaf Dec 12, 2018

ocefpaf left a comment

ocefpaf Dec 13, 2018

JarnoRFB Dec 13, 2018 •

edited

Loading

ocefpaf Dec 13, 2018

JarnoRFB Dec 13, 2018

ocefpaf Dec 13, 2018

Conengmo commented Dec 23, 2018

		@@ -232,7 +232,7 @@ class VegaLite(Element):

		def __init__(self, data, width=None, height=None,

		@@ -208,6 +210,10 @@ def render(self, **kwargs):
		name='vega_parse')


		def get_vega_versions(spec):

Use newer vega versions for altair compatibility #959

Use newer vega versions for altair compatibility #959

Conversation

JarnoRFB commented Sep 11, 2018

JarnoRFB commented Sep 11, 2018

Conengmo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JarnoRFB commented Sep 17, 2018

Conengmo commented Sep 28, 2018

JarnoRFB commented Nov 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ocefpaf commented Dec 11, 2018

JarnoRFB commented Dec 12, 2018

ocefpaf commented Dec 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ocefpaf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JarnoRFB Dec 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Conengmo commented Dec 23, 2018

JarnoRFB Dec 13, 2018 •

edited

Loading